Dapr component schema #460

FullStackChef · 2025-02-09T07:55:15Z

**Closes #459 & #507 **

PR Checklist

Created a feature/dev branch in your fork (vs. submitting directly from a commit on main)
Based off latest main branch of toolkit
PR doesn't include merge commits (always rebase on top of our main, if needed)
New integration
- Docs are written
- Added description of major feature to project description for NuGet package (4000 total character limit, so don't push entire description over that)
Tests for the changes have been added (for bug fixes / features) (if applicable)
Contains NO breaking changes
[] Every new API (including internal ones) has full XML docs
Code follows all style conventions

Other information

src/CommunityToolkit.Aspire.Hosting.Dapr/DaprDistributedApplicationLifecycleHook.cs

davidfowl · 2025-02-09T08:04:22Z

src/CommunityToolkit.Aspire.Hosting.Dapr/DaprDistributedApplicationLifecycleHook.cs

+        return await contentWriter(content).ConfigureAwait(false);
+    }
+
+    private string GetAppHostRelativePath(string componentName)


Aside, we're creating a place to store things like this in 9.1, the aspire store.

nice -Apphost relative? wanna point me to the code and I could update inline with that?

I took a look at the aspire store interface - but it looks like a place to write data to rather than a location for user defined data - the idea of the app relative path is to provide a consistent location for users to place dapr components relative to the project rather than in the userprofile directory

examples/dapr/CommunityToolkit.Aspire.Hosting.Dapr.AppHost/Program.cs

src/CommunityToolkit.Aspire.Hosting.Dapr/DaprComponentSecretAnnotation.cs

src/CommunityToolkit.Aspire.Hosting.Dapr/DaprComponentSchema.cs

…notation.cs Co-authored-by: David Fowler <[email protected]>

…hef/CommunityToolkit-Aspire into dapr-component-schema

…gram.cs Co-authored-by: David Fowler <[email protected]>

…hef/CommunityToolkit-Aspire into dapr-component-schema

src/CommunityToolkit.Aspire.Hosting.Dapr/DaprComponentSchema.cs

paule96 · 2025-02-10T08:23:07Z

Maybe if it is not to big of a no scope of this PR we should already start deviding dapr sidecar and component lifecycles to make our lifes easier later.

So that we would have two LifecycleHooks and that everytime you have something like WithReference on a sidecare you wait for this resource to complete.

With this we will have an easier life if we need to consider the endpoints to generate the correct YAML files

…ting

FullStackChef · 2025-02-10T10:12:14Z

@paule96 my preference would be not to increase the scope of the my PR and I think the concept of separating lifecycle hooks needs further thought /design

paule96 · 2025-02-10T07:49:29Z

examples/dapr/CommunityToolkit.Aspire.Hosting.Dapr.AppHost/.dapr/components/pubsub.yaml

Do we need this file still? I don't see the reference of it in the sample

this file is used by this line of the apphost

var pubSub = builder.AddDaprPubSub("pubsub")

this is not new - it's simply in a project relative location

paule96 · 2025-02-10T08:02:15Z

src/CommunityToolkit.Aspire.Hosting.Dapr/DaprDistributedApplicationLifecycleHook.cs

+        // If any of the components have secrets, we will add an on-demand secret store component.
+        if (onDemandComponents.Any(component => component.TryGetAnnotationsOfType<DaprComponentSecretAnnotation>(out var annotations) && annotations.Any()))
+        {
+            onDemandComponents.Add(new DaprComponentResource("secretstore", DaprConstants.BuildingBlocks.SecretStore));


is this really a good idea? I mean a secret store can / should have configuration.
To just generate a generic one sounds a bit confusing to me.
Maybe we should better throw an exception here, that the user forgot something to define.
If we find secrets but no secret store

I don't think it's that simple. As a developer when I'm working locally, I want to be able to reference aspire parameters in my dapr metadata. If I have set those parameters as secrets then a dapr integration should respect that and treat them as such without me having to specifically set up a component.

Especially because when my resource requires secrets aspire automatically adds these secrets to a key vault and then references the key vault

However - looking at my implementation - I have overlooked what should happen if the user has configured a secrets component which should take priority

I've looked at this again and it turns out I did consider a user defined secrets component - like the existing pubsub & state, the secretstore will infact only use the local env in the absence of a secretstore.yaml in the apphost relative component directory (apphost/.dapr/components) and the dapr default component directory (userprofile/.dapr/components)

paule96 · 2025-02-10T08:07:31Z

src/CommunityToolkit.Aspire.Hosting.Dapr/DaprDistributedApplicationLifecycleHook.cs

                string componentPath = await (component.Type switch
                {
-                    DaprConstants.BuildingBlocks.PubSub => GetPubSubAsync(component, contentWriter, cancellationToken),
-                    DaprConstants.BuildingBlocks.StateStore => GetStateStoreAsync(component, contentWriter, cancellationToken),
-                    _ => throw new InvalidOperationException($"Unsupported Dapr component type '{component.Type}'.")
+                    DaprConstants.BuildingBlocks.PubSub => GetBuildingBlockComponentAsync(component, contentWriter, "pubsub.in-memory", cancellationToken), // NOTE: In memory component can only be used within a single Dapr application.
+                    DaprConstants.BuildingBlocks.StateStore => GetBuildingBlockComponentAsync(component, contentWriter, "state.in-memory", cancellationToken),
+                    DaprConstants.BuildingBlocks.SecretStore => GetBuildingBlockComponentAsync(component, contentWriter, "secretstores.local.env", cancellationToken),
+                    _ => GetComponentAsync(component, contentWriter, cancellationToken)
                }).ConfigureAwait(false);


Why their is still a need for this switch / case?

Shouldn't we handle everything with the last line? (GetComponentAsync(component, contentWriter, cancellationToken))

because the first three cases in the switch statement handle specific building blocks with local development defaults

paule96 · 2025-02-10T08:22:00Z

examples/dapr/CommunityToolkit.Aspire.Hosting.Dapr.AppHost/Program.cs

+       .WithReference(pubSub)
       .WithDaprSidecar()


From a developer standpoint I would more expect something like:

.WithDaprSidecar() .WithReference(pubSub)

Because you configure the sidecare to use the pubSub reference as a pubsub. Not the project.
That would also mean that we would need to break with the Fluent API their or have some WithDaprSidecar parameter that accepts a action or so to configure the sidecar.

You can look for the AzurePostgreSql resource of aspire how you can configure the development contianer. I would prefer an API like their

To prevent breaking changes for now closing this comment.

this is up to the developer the both work the same

aaronpowell · 2025-02-19T03:41:46Z

/stale-extend

aaronpowell · 2025-02-26T05:51:06Z

/stale-extend

FullStackChef · 2025-02-28T19:21:09Z

Quickly added parent relationship to address #507

aaronpowell · 2025-03-02T22:51:14Z

@FullStackChef is this ready to be considered reviewable/mergable?

FullStackChef · 2025-03-02T22:54:59Z

From my point of view, yes

aaronpowell

From a purely code perspective, it looks all good, but as I'm not across this problem space I'll delegate the "does it work" stuff to others.

But if there are no complaints over the next few days I'd take that as "ready to merge"

FullStackChef added 2 commits February 9, 2025 20:52

Work in progress

b518dff

Add component models, with metadata and tests

941569a

FullStackChef requested review from WhitWaldo and paule96 as code owners February 9, 2025 07:55

FullStackChef requested review from aaronpowell and removed request for WhitWaldo and paule96 February 9, 2025 07:55

davidfowl reviewed Feb 9, 2025

View reviewed changes

src/CommunityToolkit.Aspire.Hosting.Dapr/DaprDistributedApplicationLifecycleHook.cs Outdated Show resolved Hide resolved

davidfowl reviewed Feb 9, 2025

View reviewed changes

examples/dapr/CommunityToolkit.Aspire.Hosting.Dapr.AppHost/Program.cs Outdated Show resolved Hide resolved

davidfowl reviewed Feb 9, 2025

View reviewed changes

src/CommunityToolkit.Aspire.Hosting.Dapr/DaprComponentSecretAnnotation.cs Show resolved Hide resolved

davidfowl reviewed Feb 9, 2025

View reviewed changes

src/CommunityToolkit.Aspire.Hosting.Dapr/DaprComponentSchema.cs Outdated Show resolved Hide resolved

FullStackChef and others added 6 commits February 9, 2025 21:11

Update src/CommunityToolkit.Aspire.Hosting.Dapr/DaprComponentSecretAn…

8ac830c

…notation.cs Co-authored-by: David Fowler <[email protected]>

Remove un-necessary default!

fa694c8

Merge branch 'dapr-component-schema' of https://github.com/FullStackC…

8c3c081

…hef/CommunityToolkit-Aspire into dapr-component-schema

Update examples/dapr/CommunityToolkit.Aspire.Hosting.Dapr.AppHost/Pro…

accb128

…gram.cs Co-authored-by: David Fowler <[email protected]>

Fix - set environment variables on sidecar rather than apphost

148b588

Merge branch 'dapr-component-schema' of https://github.com/FullStackC…

eb57614

…hef/CommunityToolkit-Aspire into dapr-component-schema

FullStackChef mentioned this pull request Feb 9, 2025

Add Dapr Secret Store extension dotnet/aspire#4477

Open

davidfowl reviewed Feb 9, 2025

View reviewed changes

src/CommunityToolkit.Aspire.Hosting.Dapr/DaprComponentSchema.cs Outdated Show resolved Hide resolved

FullStackChef added 3 commits February 10, 2025 07:32

Make code less "cute" for David Fowler

6d325a2

Update program - project shoudn't wait for dapr component

33fea9b

Fix component schema tests

8ab51c1

FullStackChef added 3 commits February 10, 2025 22:44

Switched rabbitmq out for redis - rabbitmq caused issues for unit tes…

d786a01

…ting

cleanup

767385e

Make secrets relative to sidecar

225a2bf

paule96 reviewed Feb 10, 2025

View reviewed changes

github-actions bot added the Stale label Feb 19, 2025

aaronpowell removed the Stale label Feb 19, 2025

github-actions bot added the Stale label Feb 25, 2025

Merge branch 'main' into dapr-component-schema

9055248

aaronpowell removed the Stale label Feb 26, 2025

FullStackChef added 2 commits February 28, 2025 20:45

Merge branch 'main' into dapr-component-schema

3bba6ee

Update - public api unshipped

1b683fa

FullStackChef requested review from WhitWaldo, paule96 and davidfowl February 28, 2025 08:34

Add parent relationship to dapr resource

38eded5

aaronpowell reviewed Mar 2, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dapr component schema #460

Dapr component schema #460

FullStackChef commented Feb 9, 2025 •

edited

Loading

davidfowl Feb 9, 2025

FullStackChef Feb 9, 2025

FullStackChef Feb 28, 2025

paule96 commented Feb 10, 2025

FullStackChef commented Feb 10, 2025

paule96 Feb 10, 2025

FullStackChef Feb 28, 2025

paule96 Feb 10, 2025

FullStackChef Feb 28, 2025

FullStackChef Feb 28, 2025

paule96 Feb 10, 2025

FullStackChef Feb 28, 2025

paule96 Feb 10, 2025

paule96 Feb 10, 2025

FullStackChef Feb 28, 2025

aaronpowell commented Feb 19, 2025

aaronpowell commented Feb 26, 2025

FullStackChef commented Feb 28, 2025

aaronpowell commented Mar 2, 2025

FullStackChef commented Mar 2, 2025

aaronpowell left a comment

Dapr component schema #460

Are you sure you want to change the base?

Dapr component schema #460

Conversation

FullStackChef commented Feb 9, 2025 • edited Loading

PR Checklist

Other information

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paule96 commented Feb 10, 2025

FullStackChef commented Feb 10, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aaronpowell commented Feb 19, 2025

aaronpowell commented Feb 26, 2025

FullStackChef commented Feb 28, 2025

aaronpowell commented Mar 2, 2025

FullStackChef commented Mar 2, 2025

aaronpowell left a comment

Choose a reason for hiding this comment

FullStackChef commented Feb 9, 2025 •

edited

Loading